/**
 * Copyright © 2016-2025 The Thingsboard Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.thingsboard.mqtt.broker.integration.api;

import io.netty.channel.EventLoopGroup;
import org.thingsboard.mqtt.broker.common.data.BasicCallback;
import org.thingsboard.mqtt.broker.common.data.event.ErrorEvent;
import org.thingsboard.mqtt.broker.common.data.integration.ComponentLifecycleEvent;
import org.thingsboard.mqtt.broker.common.data.integration.IntegrationLifecycleMsg;
import org.thingsboard.mqtt.broker.common.util.ListeningExecutor;

public interface IntegrationContext {

    IntegrationLifecycleMsg getLifecycleMsg();

    /**
     * Returns current service id that is used mostly for logging.
     *
     * @return service id
     */
    String getServiceId();

    EventLoopGroup getSharedEventLoop();

    boolean isExceptionStackTraceEnabled();

    void startProcessingIntegrationMessages(TbPlatformIntegration integration);

    void stopProcessingPersistedMessages(String integrationId);

    void clearIntegrationMessages(String integrationId);

    void onUplinkMessageProcessed(boolean success);

    void saveErrorEvent(ErrorEvent errorEvent);

    void saveLifecycleEvent(ComponentLifecycleEvent event, Exception e);

    BasicCallback getCheckConnectionCallback();

    ListeningExecutor getExternalCallExecutor();

    int getIntegrationConnectTimeoutSec();
}
